List Responses
AutomatR.GoogleForms.Activities.ListResponses
The "List Responses" activity in AutomatR is part of the Google Forms activities package, allowing you to retrieve responses for a specific Google Form. This activity streamlines the process of fetching form responses based on various parameters, enhancing the efficiency of response analysis workflows.
Properties
| Name | Description |
|---|---|
| Input | |
| Form ID | The unique identifier assigned to the Google Form for which responses should be retrieved. Only supports strings or string variables. This is a required field. |
| Filter | Returns form responses based on a filter based on timestamp. String variables containing the filter. |
| Page Size | The maximum number of responses to return. If unspecified or zero, at most 5000 responses are returned. It supports integer variables. |
| Page Token | The token for fetching the next page of responses. It supports string variables. |
| Misc | |
| Display Name | Provides a customizable name for the activity displayed in the workflow. The display name enhances clarity and organization within the automation project. String variables containing the desired display name. |
| Optional | |
| Delay | Specifies the amount of time (in seconds) to wait before starting the activity. Useful for handling synchronization issues. Integer variables containing the delay duration. Example: If the amount of time is 1000 milliseconds or 1 sec, i.e., 1. |
| Output | |
| Responses | The returned form responses. Note: The formId field is not returned in the FormResponse object for list requests. Variables of type ListFormResponsesResponse to store the responses. |
| Next Page Token | If set, there are more responses. To get the next page of responses, provide this as the pageToken in a future request. String variables to store the next page token. |
How to use:
- Drag and drop the "List Responses" activity onto the workflow.
- Configure the properties by providing the necessary details such as Form ID, Filter, Page Size, and Page Token.
- Optionally, configure the delay before starting the activity.
- Execute the workflow to list the responses for the specified Google Form.
Example:
Consider an example where the "List Responses" activity is used to retrieve responses for a Google Form:
List Responses:
Form ID: formIdVariable
Filter: "timestamp > 2023-08-28T11:10:00.000Z"
Page Size: 10
Page Token: nextPageTokenVariable
Responses: formResponsesVariable
Next Page Token: nextPageTokenVariable
In this example, the activity lists responses for the specified Google Form using a filter based on the timestamp. The page size is set to 10, and the responses are stored in the variable formResponsesVariable. The next page token, if available, is stored in the variable nextPageTokenVariable for fetching the next set of responses in subsequent requests.